Support setting domain id for Context #1164
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for setting the domain id for the Context, ensuring that the domain id is handled and returned as a BigInt throughout the API. Key changes include:
- Adjusting type assertions in tests to expect BigInt for domain ids.
- Updating the C++ bindings to accept an optional BigInt argument and return a BigInt.
- Modifying the Context API and initialization code in JavaScript to handle the new domain id.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| test/types/index.test-d.ts | Updated tests to verify the new BigInt type for domain id. |
| test/test-context.js | Modified tests to reflect the updated domain id expectations. |
| src/rcl_context_bindings.cpp | Changed bindings to accept and return BigInt; added scope_exit for cleanup. |
| lib/context.js | Updated the Context constructor and getter to use domain id as BigInt. |
| index.js | Passed the domain id from the Context instance to the initialization API. |
Comments suppressed due to low confidence (1)
lib/context.js:68
- [nitpick] Consider providing a default value (e.g., 0n) for the domainId parameter in the Context constructor to ensure that this._domainId is always a BigInt, which will clarify the API contract for users.
constructor(domainId) {
| size_t domain_id = RCL_DEFAULT_DOMAIN_ID; | ||
| if (info.Length() > 2 && info[2].IsBigInt()) { | ||
| bool lossless; | ||
| domain_id = info[2].As<Napi::BigInt>().Uint64Value(&lossless); |
There was a problem hiding this comment.
[nitpick] Consider checking if the BigInt conversion was lossless by verifying the 'lossless' boolean value; if the conversion is not lossless, it may be appropriate to throw an error to prevent potential data truncation.
Suggested change
| domain_id = info[2].As<Napi::BigInt>().Uint64Value(&lossless); | |
| domain_id = info[2].As<Napi::BigInt>().Uint64Value(&lossless); | |
| if (!lossless) { | |
| Napi::Error::New(env, "BigInt conversion to domain_id was not lossless") | |
| .ThrowAsJavaScriptException(); | |
| return env.Undefined(); | |
| } |
minggangw
added a commit
that referenced
this pull request
Jun 18, 2025
This PR adds support for setting the domain id for the Context, ensuring that the domain id is handled and returned as a BigInt throughout the API. Key changes include: - Adjusting type assertions in tests to expect BigInt for domain ids. - Updating the C++ bindings to accept an optional BigInt argument and return a BigInt. - Modifying the Context API and initialization code in JavaScript to handle the new domain id. Fix: #1163
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for setting the domain id for the Context, ensuring that the domain id is handled and returned as a BigInt throughout the API. Key changes include:
Fix: #1163